<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - $.dom.DOMTokenList</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><a href="../symbols/%24.html">$</a></li>
	
	<li><a href="../symbols/%24.browser.html">$.browser</a></li>
	
	<li><a href="../symbols/%24.dom.html">$.dom</a></li>
	
	<li><a href="../symbols/%24.dom.DOMTokenList.html">$.dom.DOMTokenList</a></li>
	
	<li><a href="../symbols/%24.dom.Element.html">$.dom.Element</a></li>
	
	<li><a href="../symbols/%24.dom.HTMLElement.html">$.dom.HTMLElement</a></li>
	
	<li><a href="../symbols/%24.dom.KeyboardEvent.html">$.dom.KeyboardEvent</a></li>
	
	<li><a href="../symbols/%24.dom.KeyboardEventListener.html">$.dom.KeyboardEventListener</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes.html">$.dom.keyCodes</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes_fixes.html">$.dom.keyCodes_fixes</a></li>
	
	<li><a href="../symbols/%24.dom.keyCodes_Safari2.html">$.dom.keyCodes_Safari2</a></li>
	
	<li><a href="../symbols/%24.dom.keyNames.html">$.dom.keyNames</a></li>
	
	<li><a href="../symbols/%24.dom.Node.html">$.dom.Node</a></li>
	
	<li><a href="../symbols/%24.dom.NodeList.html">$.dom.NodeList</a></li>
	
	<li><a href="../symbols/%24.js.html">$.js</a></li>
	
	<li><a href="../symbols/%24.js.Array.html">$.js.Array</a></li>
	
	<li><a href="../symbols/%24.js.Object.html">$.js.Object</a></li>
	
	<li><a href="../symbols/%24.js.String.html">$.js.String</a></li>
	
	<li><a href="../symbols/%24.profiler.html">$.profiler</a></li>
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class $.dom.DOMTokenList
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				Represents a DOMTokenList object.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_core-dom.js.html">core-dom.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class $.dom.DOMTokenList.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/%24.dom.DOMTokenList.html">$.dom.DOMTokenList</a></b>(elem, attr)
							</div>
							<div class="description">Creates a new DOMTokenList object.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class $.dom.DOMTokenList.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/%24.dom.DOMTokenList.html#length">length</a></b>
								</div>
								<div class="description">The number of tokens in the current list.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class $.dom.DOMTokenList.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#add">add</a></b>(token)
								</div>
								<div class="description">Add the <var>token</var> to the current list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#has">has</a></b>(token)
								</div>
								<div class="description">Check if the <var>token</var> is in the current list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#item">item</a></b>(index)
								</div>
								<div class="description">Retrieve the <var>index</var>th token.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#remove">remove</a></b>(token)
								</div>
								<div class="description">Remove the <var>token</var> from the current list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#toggle">toggle</a></b>(token)
								</div>
								<div class="description">Toggle the presence of <var>token</var> in the current list.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#toString">toString</a></b>()
								</div>
								<div class="description">Convert the current list to a string.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#-update">update</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;private&gt; &lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/%24.dom.DOMTokenList.html#-update_indexes">update_indexes</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>$.dom.DOMTokenList</b>(elem, attr)
				</div>
				
				<div class="description">
					Creates a new DOMTokenList object.

<p>The <a 
href="http://www.whatwg.org/specs/web-apps/current-work/#domtokenlist">DOMTokenList 
interface</a> is defined by the HTML 5 specification.  It is used for all 
HTMLElements for the new classList property, and for other properties on 
other HTML elements.

<p>This library implements the DOMTokenList interface, to be used in Web 
browsers which do not have it natively implemented. The level of the 
implementation should be close to a native one, in terms of usage from other 
scripts. However, it's slower and might have some "gotchas" in corner-cases.
					
				</div>
				
				
				
				<pre class="code">// Let's work with the list of class names for the document body.
<code>var <var>elem</var> = document.body;
var <var>list</var> = new $.dom.DOMTokenList(<var>elem</var>, 'className');
<var>list</var>.add('test');
<var>list</var>.add('test2');
<var>list</var>[0]; // returns 'test'
<var>list</var>.length; // returns 2
<var>elem</var>.className; // returns 'test test2'
<var>list</var>.toggle('test2'); // returns false
<var>list</var>.has('test2'); // returns false
<var>list</var>.has('test'); // returns true
<var>list</var>.remove('test');</code></pre>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{HTMLElement}</span>  <b>elem</b>
								
							</dt>
								<dd>The element you want the DOMTokenList object for.</dd>
						
							<dt>
								<span class="light fixedFont">{String}</span>  <b>attr</b>
								
							</dt>
								<dd>The attribute you want the DOMTokenList for.</dd>
						
						</dl>
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Returns:</dt>
						
								<dd><span class="light fixedFont">{DOMTokenList}</span> The DOMTokenList object.</dd>
						
						</dl>
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="length"> </a>
					<div class="fixedFont">
					
					<span class="light">{Number}</span>
					<b>length</b>
					
					</div>
					<div class="description">
						The number of tokens in the current list.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="add"> </a>
					<div class="fixedFont">
					
					
					<b>add</b>(token)
					
					</div>
					<div class="description">
						Add the <var>token</var> to the current list.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>token</b>
									
								</dt>
								<dd>The token you want to add.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Throws:</dt>
							
								<dt>
									<span class="light fixedFont">{DOMException.INVALID_CHARACTER_ERR|Error}</span>  <b></b>
								</dt>
								<dd>If <var>token</var> 
contains a space character.</dd>
							
							</dl>
						
						
						
						

					<hr />
				
					<a name="has"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean}</span>
					<b>has</b>(token)
					
					</div>
					<div class="description">
						Check if the <var>token</var> is in the current list.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>token</b>
									
								</dt>
								<dd>The token you want to check.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Throws:</dt>
							
								<dt>
									<span class="light fixedFont">{DOMException.INVALID_CHARACTER_ERR|Error}</span>  <b></b>
								</dt>
								<dd>If <var>token</var> 
contains a space character.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True is returned if the <var>token</var> was found in 
the current list, otherwise false is returned.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="item"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>item</b>(index)
					
					</div>
					<div class="description">
						Retrieve the <var>index</var>th token.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>index</b>
									
								</dt>
								<dd>The zero-based index/position of the token you want.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The token found at the <var>index</var> position in the 
list.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="remove"> </a>
					<div class="fixedFont">
					
					
					<b>remove</b>(token)
					
					</div>
					<div class="description">
						Remove the <var>token</var> from the current list.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>token</b>
									
								</dt>
								<dd>The token you want to remove.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Throws:</dt>
							
								<dt>
									<span class="light fixedFont">{DOMException.INVALID_CHARACTER_ERR|Error}</span>  <b></b>
								</dt>
								<dd>If <var>token</var> 
contains a space character.</dd>
							
							</dl>
						
						
						
						

					<hr />
				
					<a name="toggle"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean}</span>
					<b>toggle</b>(token)
					
					</div>
					<div class="description">
						Toggle the presence of <var>token</var> in the current list.

<p>If the <var>token</var> is found in the current list, it is removed.  
Otherwise, the <var>token</var> is added.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>token</b>
									
								</dt>
								<dd>The token you want to add/remove.</dd>
							
							</dl>
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Throws:</dt>
							
								<dt>
									<span class="light fixedFont">{DOMException.INVALID_CHARACTER_ERR|Error}</span>  <b></b>
								</dt>
								<dd>If <var>token</var> 
contains a space character.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True is returned if the <var>token</var> was added.  
Otherwise, false is returned.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="toString"> </a>
					<div class="fixedFont">
					
					<span class="light">{String}</span>
					<b>toString</b>()
					
					</div>
					<div class="description">
						Convert the current list to a string. All the tokens are separated by 
a space character, something like "token1 token2 tokenn".
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{String}</span> The list of tokens, separated by a space character.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="-update"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;inner&gt; 
					
					
					<b>update</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="-update_indexes"> </a>
					<div class="fixedFont">&lt;private&gt; &lt;inner&gt; 
					
					
					<b>update_indexes</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Mon May 11 2009 19:36:21 GMT+0300 (EEST)
		</div>
	</body>
</html>
